-
Notifications
You must be signed in to change notification settings - Fork 614
(maint) Updating changelog generator config #1280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(maint) Updating changelog generator config #1280
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would expect to see a change in Rakefile
to reflect this.
Note - failures in spec tests are unrelated to this PR. |
I'd recommend just fixing the formatting of line 1 of the HISTORY.MD file. Then |
Fix to what? |
I think just adding a release date in brackets should do it. Will have a go later. |
Actually, it's fine as is (without adding a date). It's already being correctly parsed from HISTORY.md. |
.sync.yml
Outdated
@@ -10,6 +10,7 @@ Gemfile: | |||
- gem: github_changelog_generator | |||
Rakefile: | |||
changelog_user: puppetlabs | |||
changelog_since_tag: '5.3.0' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is actually redundant. The HISTORY.md file is formatted in such a way that this will be automatically discovered.
Rakefile
Outdated
@@ -48,6 +48,7 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? | |||
raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil? | |||
config.user = "#{changelog_user}" | |||
config.project = "#{changelog_project}" | |||
config.since_tag = "5.3.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line can go too.
be1b85d
to
bcc1181
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yay for less code.
…gelog_config (maint) Updating changelog generator config
Following discussion, with the HISTORY.md file formatting (## 5.3.0) the changelog generator is clever enough to pick it up as the since_tag therefore the only change made here is to remove and
.github_changelog_generator
file.